// This example shows how to subscribe to all metrics of a given edge node, with authentication. // // In order to publish or observe messages for this example, start the SparkplugEdgeNodeConsoleDemo program first. // The username and password must match the ones used by the MQTT broker. // // Find all latest examples here: https://opclabs.doc-that.com/files/onlinedocs/OPCLabs-ConnectivityStudio/Latest/examples.html . // Sparkplug examples in C# on GitHub: https://github.com/OPCLabs/Examples-ConnectivityStudio-CSharp . // Missing some example? Ask us for it on our Online Forums, https://www.opclabs.com/forum/index ! You do not have to own // a commercial license in order to use Online Forums, and we reply to every post. using System; using OpcLabs.EasySparkplug; using OpcLabs.EasySparkplug.OperationModel; namespace SparkplugDocExamples.Consumer._EasySparkplugConsumer { partial class SubscribeEdgeNodeMetric { public static void Authentication() { // The username and password can be specified in the broker descriptor, as below. // Note that the default port for the "mqtt" scheme is 1883. var brokerDescriptor = new SparkplugBrokerDescriptor("mqtt://localhost") { UserName = "admin", Password = "password" }; var hostDescriptor = new SparkplugHostDescriptor(brokerDescriptor); // Alternatively, if you do not mind, the MQTT broker URL can directly include the username and password, // as below. // Note that regardless of how the broker descriptor is constructed, the username and password are transferred // in plain text on the wire, unless encryption is used (e.g., using TLS or WSS - see other examples). var hostDescriptor2 = new SparkplugHostDescriptor("mqtt://admin:password@localhost"); // Instantiate the consumer object and hook events. var consumer = new EasySparkplugConsumer(); consumer.MetricNotification += consumer_Authentication_MetricNotification; Console.WriteLine("Subscribing..."); // In this example, we specify the precise Sparkplug group ID and edge node ID, but allow any metric name. consumer.SubscribeEdgeNodeMetric(hostDescriptor, // or hostDescriptor2, if you prefer the alternative method "easyGroup", "easySparkplugDemo", "#"); Console.WriteLine("Processing notifications for 20 seconds..."); System.Threading.Thread.Sleep(20 * 1000); Console.WriteLine("Unsubscribing..."); consumer.UnsubscribeAllMetrics(); Console.WriteLine("Waiting for 5 seconds..."); System.Threading.Thread.Sleep(5 * 1000); Console.WriteLine("Finished."); } static void consumer_Authentication_MetricNotification(object sender, EasySparkplugMetricNotificationEventArgs eventArgs) { // Handle different types of notifications. Console.WriteLine(); switch (eventArgs.NotificationType) { case SparkplugNotificationType.Connect: Console.WriteLine($"Connected to Sparkplug host, client ID: {eventArgs.ClientId}."); break; case SparkplugNotificationType.Disconnect: Console.WriteLine("Disconnected from Sparkplug host."); break; case SparkplugNotificationType.Data: Console.WriteLine("Received data from Sparkplug host."); Console.WriteLine($"Metric name: {eventArgs.MetricName}"); Console.WriteLine($"Value: {eventArgs.MetricData?.Value}"); break; case SparkplugNotificationType.Birth: Console.WriteLine("Received birth message from Sparkplug host."); Console.WriteLine($"Metric name: {eventArgs.MetricName}"); Console.WriteLine($"Value: {eventArgs.MetricData?.Value}"); break; case SparkplugNotificationType.Death: Console.WriteLine("Received death message from Sparkplug host."); Console.WriteLine($"Metric name: {eventArgs.MetricName}"); break; } if (!eventArgs.Succeeded) Console.WriteLine($"*** Failure: {eventArgs.ErrorMessageBrief}"); } } }
' This example shows how to subscribe to all metrics of a given edge node, with authentication. ' ' In order to publish or observe messages for this example, start the SparkplugEdgeNodeConsoleDemo program first. ' ' Find all latest examples here: https://opclabs.doc-that.com/files/onlinedocs/OPCLabs-ConnectivityStudio/Latest/examples.html . ' Sparkplug examples in C# on GitHub: https://github.com/OPCLabs/Examples-ConnectivityStudio-CSharp . ' Missing some example? Ask us for it on our Online Forums, https://www.opclabs.com/forum/index ! You do not have to own ' a commercial license in order to use Online Forums, and we reply to every post. Imports OpcLabs.EasySparkplug Imports OpcLabs.EasySparkplug.OperationModel Namespace Global.SparkplugDocExamples.Consumer._EasySparkplugConsumer Partial Class SubscribeEdgeNodeMetric Public Shared Sub Authentication() ' The username and password can be specified in the broker descriptor, as below. ' Note that the default port for the "mqtt" scheme is 1883. Dim brokerDescriptor = New SparkplugBrokerDescriptor("mqtt://localhost") With { .UserName = "admin", .Password = "password" } Dim hostDescriptor = New SparkplugHostDescriptor(brokerDescriptor) ' Alternatively, if you do not mind, the MQTT broker URL can directly include the username and password, ' as below. ' Note that regardless of how the broker descriptor is constructed, the username and password are transferred ' in plain text on the wire, unless encryption is used (e.g., using TLS or WSS - see other examples). Dim hostDescriptor2 = New SparkplugHostDescriptor("mqtt://admin:password@localhost") ' Instantiate the consumer object and hook events. Dim consumer = New EasySparkplugConsumer() AddHandler consumer.MetricNotification, AddressOf consumer_Authentication_MetricNotification Console.WriteLine("Subscribing...") ' In this example, we specify the precise Sparkplug group ID and edge node ID, but allow any metric name. consumer.SubscribeEdgeNodeMetric(hostDescriptor, ' or hostDescriptor2, if you prefer the alternative method "easyGroup", "easySparkplugDemo", "#") Console.WriteLine("Processing notifications for 20 seconds...") Threading.Thread.Sleep(20 * 1000) Console.WriteLine("Unsubscribing...") consumer.UnsubscribeAllMetrics() Console.WriteLine("Waiting for 5 seconds...") Threading.Thread.Sleep(5 * 1000) Console.WriteLine("Finished.") End Sub Private Shared Sub consumer_Authentication_MetricNotification(ByVal sender As Object, ByVal eventArgs As EasySparkplugMetricNotificationEventArgs) ' Handle different types of notifications. Console.WriteLine() Select Case eventArgs.NotificationType Case SparkplugNotificationType.Connect Console.WriteLine($"Connected to Sparkplug host, client ID: {eventArgs.ClientId}.") Case SparkplugNotificationType.Disconnect Console.WriteLine("Disconnected from Sparkplug host.") Case SparkplugNotificationType.Data Console.WriteLine("Received data from Sparkplug host.") Console.WriteLine($"Metric name: {eventArgs.MetricName}") Console.WriteLine($"Value: {eventArgs.MetricData?.Value}") Case SparkplugNotificationType.Birth Console.WriteLine("Received birth message from Sparkplug host.") Console.WriteLine($"Metric name: {eventArgs.MetricName}") Console.WriteLine($"Value: {eventArgs.MetricData?.Value}") Case SparkplugNotificationType.Death Console.WriteLine("Received death message from Sparkplug host.") Console.WriteLine($"Metric name: {eventArgs.MetricName}") End Select If Not eventArgs.Succeeded Then Console.WriteLine($"*** Failure: {eventArgs.ErrorMessageBrief}") End If End Sub End Class End Namespace
Copyright © 2004-2025 CODE Consulting and Development, s.r.o., Plzen. All rights reserved. Web page: www.opclabs.com
Documentation Home, Send Feedback. Resources: Knowledge Base, Product Downloads. Technical support: Online Forums, FAQ.Missing some example? Ask us for it on our Online Forums! You do not have to own a commercial license in order to use Online Forums, and we reply to every post.